<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>MeteoLib参考文档: 命名空间: Fullscreen</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">命名空间: Fullscreen</h1>

    




<section>

<header>
    
        <h2>
        Fullscreen
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
            <div class="description">Browser-independent functions for working with the standard fullscreen API.</div>
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9050">line 9050</a>
    </li></ul></dd>
    

    

    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http://dvcs.w3.org/hg/fullscreen/raw-file/tip/Overview.html">W3C Fullscreen Living Specification</a></li>
        </ul>
    </dd>
    

    
</dl>


        
    
    </div>

    

    

    

     

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id=".changeEventName"><span class="type-signature">(static, readonly) </span>changeEventName<span class="type-signature"> :String</span></h4>




<div class="description">
    The name of the event on the document that is fired when fullscreen is
entered or exited.  This event name is intended for use with addEventListener.
In your event handler, to determine if the browser is in fullscreen mode or not,
use Fullscreen#fullscreen.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9079">line 9079</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".element"><span class="type-signature">(static, readonly) </span>element<span class="type-signature"> :Object</span></h4>




<div class="description">
    The element that is currently fullscreen, if any.  To simply check if the
browser is in fullscreen mode or not, use Fullscreen#fullscreen.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9060">line 9060</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".enabled"><span class="type-signature">(static, readonly) </span>enabled<span class="type-signature"> :Boolean</span></h4>




<div class="description">
    Determine whether the browser will allow an element to be made fullscreen, or not.
For example, by default, iframes cannot go fullscreen unless the containing page
adds an "allowfullscreen" attribute (or prefixed equivalent).
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9114">line 9114</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".errorEventName"><span class="type-signature">(static, readonly) </span>errorEventName<span class="type-signature"> :String</span></h4>




<div class="description">
    The name of the event that is fired when a fullscreen error
occurs.  This event name is intended for use with addEventListener.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9096">line 9096</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id=".fullscreen"><span class="type-signature">(static, readonly) </span>fullscreen<span class="type-signature"> :Boolean</span></h4>




<div class="description">
    Determines if the browser is currently in fullscreen mode.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9130">line 9130</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    <h4 class="name" id=".exitFullscreen"><span class="type-signature">(static) </span>exitFullscreen<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Asynchronously exits fullscreen mode.  If the browser is not currently
in fullscreen, or if fullscreen mode is not supported by the browser, does nothing.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9269">line 9269</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id=".requestFullscreen"><span class="type-signature">(static) </span>requestFullscreen<span class="signature">(element, vrDevice<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Asynchronously requests the browser to enter fullscreen mode on the given element.
If fullscreen mode is not supported by the browser, does nothing.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">The HTML element which will be placed into fullscreen mode.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>vrDevice</code></td>
            

            <td class="type">
            
                
<span class="param-type">HMDVRDevice</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">The VR device.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9257">line 9257</a>
    </li></ul></dd>
    

    

    

    
</dl>















    <h5>Example</h5>
    
    <pre class="prettyprint"><code>// Put the entire page into fullscreen.
Cesium.Fullscreen.requestFullscreen(document.body)

// Place only the Cesium canvas into fullscreen.
Cesium.Fullscreen.requestFullscreen(scene.canvas)</code></pre>



        
            

    

    <h4 class="name" id=".supportsFullscreen"><span class="type-signature">(static) </span>supportsFullscreen<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>

    



<div class="description">
    Detects whether the browser supports the standard fullscreen API.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="CesiumVectorTile.pure.js.html">CesiumVectorTile.pure.js</a>, <a href="CesiumVectorTile.pure.js.html#line9147">line 9147</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    <code>true</code> if the browser supports the standard fullscreen API,
<code>false</code> otherwise.
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    



        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">主页</a></h2><h3>命名空间</h3><ul><li><a href="Cesium.html">Cesium</a></li><li><a href="Fullscreen.html">Fullscreen</a></li></ul><h3>类</h3><ul><li><h5><a href="Cesium.html">Cesium</a></h5></li><li><a href="Cesium.Path.html">Path</a></li><li><a href="Cesium.VectorStyle.html">VectorStyle</a></li><li><a href="Cesium.VectorTileImageryProvider.html">VectorTileImageryProvider</a></li></ul><h3>Modules</h3><ul><li><a href="module-clone.html">clone</a></li><li><a href="module-combine.html">combine</a></li><li><a href="module-defaultValue.html">defaultValue</a></li><li><a href="module-defined.html">defined</a></li><li><a href="module-destroyObject.html">destroyObject</a></li><li><a href="module-FeatureDetection.html">FeatureDetection</a></li><li><a href="module-getAbsoluteUri.html">getAbsoluteUri</a></li><li><a href="module-getBaseUri.html">getBaseUri</a></li><li><a href="module-getExtensionFromUri.html">getExtensionFromUri</a></li><li><a href="module-isArray.html">isArray</a></li><li><a href="module-Math.html">Math</a></li><li><a href="module-objectToQuery.html">objectToQuery</a></li><li><a href="module-queryToObject.html">queryToObject</a></li><li><a href="module-Request.html">Request</a></li><li><a href="module-RequestState.html">RequestState</a></li><li><a href="module-RequestType.html">RequestType</a></li><li><a href="module-TrustedServers.html">TrustedServers</a></li><li><a href="module-writeTextToCanvas.html">writeTextToCanvas</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jul 23 2021 23:41:58 GMT+0800 (GMT+08:00)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>